<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class Hierarchy</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="SatStress-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/satstress">SatStress</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">&nbsp;</td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<center><b>
 [ <a href="module-tree.html">Module Hierarchy</a>
 | <a href="class-tree.html">Class Hierarchy</a> ]
</b></center><br />
<h1 class="epydoc">Class Hierarchy</h1>
<ul class="nomargin-top">
    <li> <strong class="uidlink"><a href="SatStress.GridCalc.Grid-class.html">SatStress.GridCalc.Grid</a></strong>:
      <em class="summary">A container class defining the temporal and geographic range and 
        resolution of the calculation.</em>
    </li>
    <li> <strong class="uidlink">object</strong>:
      <em class="summary">The most base type</em>
    <ul>
    <li> <strong class="uidlink">exceptions.BaseException</strong>:
      <em class="summary">Common base class for all exceptions</em>
    <ul>
    <li> <strong class="uidlink">exceptions.Exception</strong>:
      <em class="summary">Common base class for all non-exit exceptions.</em>
    <ul>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.Error-class.html">SatStress.SatStress.Error</a></strong>:
      <em class="summary">Base class for errors within the SatStress module.</em>
    <ul>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.NameValueFileError-class.html">SatStress.SatStress.NameValueFileError</a></strong>:
      <em class="summary">Base class for errors related to NAME=VALUE style input files.</em>
    <ul>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.NameValueFileDuplicateNameError-class.html">SatStress.SatStress.NameValueFileDuplicateNameError</a></strong>:
      <em class="summary">Indicates multiple copies of the same name in an input file.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.NameValueFileParseError-class.html">SatStress.SatStress.NameValueFileParseError</a></strong>:
      <em class="summary">Indicates a poorly formatted NAME=VALUE files.</em>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.SatelliteParamError-class.html">SatStress.SatStress.SatelliteParamError</a></strong>:
      <em class="summary">Indicates a problem with the Satellite initialization.</em>
    <ul>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.InvalidSatelliteParamError-class.html">SatStress.SatStress.InvalidSatelliteParamError</a></strong>:
      <em class="summary">Raised when a required parameter is not found in the input file.</em>
    <ul>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.ExcessiveSatelliteMassError-class.html">SatStress.SatStress.ExcessiveSatelliteMassError</a></strong>:
      <em class="summary">Raised if the satellite's parent planet is less than 10x as massive
        as the satellite.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.GravitationallyUnstableSatelliteError-class.html">SatStress.SatStress.GravitationallyUnstableSatelliteError</a></strong>:
      <em class="summary">Raised if the density of layers is found not to decrease as you 
        move toward the surface from the center of the satellite.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.InvalidLoveNumberError-class.html">SatStress.SatStress.InvalidLoveNumberError</a></strong>:
      <em class="summary">Raised if the Love numbers are found to be suspicious.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.LargeEccentricityError-class.html">SatStress.SatStress.LargeEccentricityError</a></strong>:
      <em class="summary">Raised when satellite orbital eccentricity is &gt; 0.25</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.LoveExcessiveDeltaError-class.html">SatStress.SatStress.LoveExcessiveDeltaError</a></strong>:
      <em class="summary">Raised when &Delta; &gt; 10^9 for any of the ice layers, at which 
        point the Love number code becomes unreliable.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.LoveLayerNumberError-class.html">SatStress.SatStress.LoveLayerNumberError</a></strong>:
      <em class="summary">Raised if the number of layers specified in the satellite 
        definition file is incompatible with the Love number code.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.LowLayerDensityError-class.html">SatStress.SatStress.LowLayerDensityError</a></strong>:
      <em class="summary">Indicates that a layer has been assigned an unrealistically low 
        density.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.LowLayerThicknessError-class.html">SatStress.SatStress.LowLayerThicknessError</a></strong>:
      <em class="summary">Indicates that a layer has been given too small of a thickness</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.NegativeLayerParamError-class.html">SatStress.SatStress.NegativeLayerParamError</a></strong>:
      <em class="summary">Indicates a layer has been given an unphysical material property.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.NegativeNSRPeriodError-class.html">SatStress.SatStress.NegativeNSRPeriodError</a></strong>:
      <em class="summary">Raised if the satellite's NSR period is less than zero</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.NonNumberSatelliteParamError-class.html">SatStress.SatStress.NonNumberSatelliteParamError</a></strong>:
      <em class="summary">Indicates that a non-numeric value was found for a numerical 
        parameter.</em>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.MissingSatelliteParamError-class.html">SatStress.SatStress.MissingSatelliteParamError</a></strong>:
      <em class="summary">Indicates a required parameter was not found in the input file.</em>
    </li>
    </ul>
    </li>
    </ul>
    </li>
    </ul>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.LoveNum-class.html">SatStress.SatStress.LoveNum</a></strong>:
      <em class="summary">A container class for the complex Love numbers: h2, k2, and l2.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.SatLayer-class.html">SatStress.SatStress.SatLayer</a></strong>:
      <em class="summary">An object describing a uniform material layer within a satellite.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.Satellite-class.html">SatStress.SatStress.Satellite</a></strong>:
      <em class="summary">An object describing the physical structure and context of a 
        satellite.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.StressCalc-class.html">SatStress.SatStress.StressCalc</a></strong>:
      <em class="summary">An object which calculates the stresses on the surface of a <a 
        href="SatStress.SatStress.Satellite-class.html" 
        class="link">Satellite</a> that result from one or more stress 
        fields.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.StressDef-class.html">SatStress.SatStress.StressDef</a></strong>:
      <em class="summary">A base class from which particular tidal stress field objects 
        descend.</em>
    <ul>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.Diurnal-class.html">SatStress.SatStress.Diurnal</a></strong>:
      <em class="summary">An object defining the stress field that arises on a satellite due 
        to an eccentric orbit.</em>
    </li>
    <li> <strong class="uidlink"><a href="SatStress.SatStress.NSR-class.html">SatStress.SatStress.NSR</a></strong>:
      <em class="summary">An object defining the stress field which arises from the 
        non-synchronous rotation (NSR) of a satellite's icy shell.</em>
    </li>
    </ul>
    </li>
    </ul>
    </li>
</ul>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="SatStress-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/satstress">SatStress</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Mar 28 13:31:50 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
